org.eclipse.vtp.framework.interactions.voice.vxml
Class Recording

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.support.Widget
      org.eclipse.vtp.framework.interactions.voice.vxml.FormElement
          org.eclipse.vtp.framework.interactions.voice.vxml.Recording

All Implemented Interfaces:

VXMLConstants

public class Recording
extends FormElement

The Recording class represents the <record> VXML element.

Version:

2.0

Author:

Trip Gilman, Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.interactions.voice.vxml.VXMLConstants

EMPTY, FILE_EXT_GSL, FILLED_MODE_ALL, FILLED_MODE_ANY, GRAMMAR_MODE_DTMF, GRAMMAR_MODE_VOICE, METHOD_GET, METHOD_POST, MIME_TYPE_GSL, MIME_TYPE_SRGS, NAME_APPLICATION, NAME_ASSIGN, NAME_AUDIO, NAME_BARGEIN, NAME_BEEP, NAME_BLOCK, NAME_BRIDGE, NAME_CATCH, NAME_CHOICE, NAME_COMPLETETIMEOUT, NAME_COND, NAME_CONFIDENCELEVEL, NAME_COUNT, NAME_DEST, NAME_DISCONNECT, NAME_DTMF, NAME_DTMFTERM, NAME_ELSE, NAME_ELSEIF, NAME_ENCTYPE, NAME_ENUMERATE, NAME_ERROR, NAME_EVENT, NAME_EVENTEXPR, NAME_EXIT, NAME_EXPR, NAME_FIELD, NAME_FILLED, NAME_FINALSILENCE, NAME_FORM, NAME_GOTO, NAME_GRAMMAR, NAME_ID, NAME_IF, NAME_INCOMPLETETIMEOUT, NAME_INPUTMODES, NAME_INTERDIGITTIMEOUT, NAME_ITEM, NAME_MAXNBEST, NAME_MAXSPEECHTIMEOUT, NAME_MAXTIME, NAME_MENU, NAME_METHOD, NAME_MODE, NAME_NAME, NAME_NAMELIST, NAME_NEXT, NAME_NOINPUT, NAME_NOMATCH, NAME_ONE_OF, NAME_OPTION, NAME_PARAM, NAME_PROMPT, NAME_PROPERTY, NAME_RECORD, NAME_REPEAT, NAME_REPROMPT, NAME_RETURN, NAME_ROOT, NAME_RULE, NAME_SCOPE, NAME_SCRIPT, NAME_SENSITIVITY, NAME_SPEEDVSACCURACY, NAME_SRC, NAME_SUBDIALOG, NAME_SUBMIT, NAME_TERMCHAR, NAME_TERMTIMEOUT, NAME_THROW, NAME_TIMEOUT, NAME_TRANSFER, NAME_TYPE, NAME_VALUE, NAME_VAR, NAME_VERSION, NAME_VXML, NAMESPACE_URI_VXML, QNAME_XML_LANG, SCOPE_DIALOG, SCOPE_DOCUMENT, TYPE_CDATA, VERSION_2_0

Constructor Summary

Recording(java.lang.String name)
Creates a new instance of a Recording element.

Recording(java.lang.String name, java.lang.String expression)
Creates a new instance of a Recording element.

Recording(java.lang.String name, java.lang.String expression, java.lang.String condition)
Creates a new instance of a Recording element.

Method Summary

void	addEventHandler(EventHandler eventHandler) Adds the specified event handler to this recording.
void	addFilledHandler(Filled filled) Adds the specified filled handler to this recording.
void	clearProperty(java.lang.String propertyName) Clears the value of a property in this recording.
java.lang.String	getFileType() Returns the file type setting.
java.lang.String	getFinalSilence() Returns the final silence setting.
java.lang.String	getMaxtime() Returns the maximum recording time setting.
Prompt	getPrompt() Returns the opening prompt played to the caller.
java.lang.String[]	getPropertyNames() Returns the names of the properties of this recording.
java.lang.String	getPropertyValue(java.lang.String propertyName) Returns the value of the specified property or null if no such property exists.
java.lang.String	getTimeout() Returns the time out of the opening prompt.
boolean	isBeepEnabled() Returns the beep toggle setting.
boolean	isDtmfTermEnabled() Returns the DTMF toggle setting.
void	removeEventHandler(EventHandler eventHandler) Removes the specified event handler from this recording.
void	removeFilledHandler(Filled filled) Removes the specified filled handler from this recording.
void	setBeepEnabled(boolean beepEnabled) Sets the beep toggle setting.
void	setDtmfTermEnabled(boolean dtmfTermEnabled) Sets the DTMF toggle setting.
void	setFileType(java.lang.String fileType) Sets the file type setting.
void	setFinalSilence(java.lang.String finalSilence) Sets the final silence setting.
void	setMaxtime(java.lang.String maxtime) Sets the maximum recording time setting.
void	setPrompt(Prompt prompt) Sets the opening prompt played to the caller.
void	setProperty(java.lang.String propertyName, java.lang.String propertyValue) Sets the value of a property in this recording.
void	setTimeout(java.lang.String timeout) Sets the time out of the opening prompt.
protected void	writeAttributes(org.xml.sax.helpers.AttributesImpl attributes) Write the attribute members of this form element to the supplied set.
protected void	writeEventHandlers(org.xml.sax.ContentHandler outputHandler) Write the event handlers of this field to the specified content handler.
protected void	writeFilledHandlers(org.xml.sax.ContentHandler outputHandler) Write the filled handlers of this field to the specified content handler.
protected void	writePrompt(org.xml.sax.ContentHandler outputHandler) Writes this field's prompt to the specified content handler.
protected void	writeProperties(org.xml.sax.ContentHandler outputHandler) Writes the properties of this field to the specified content handler.
void	writeWidget(org.xml.sax.ContentHandler outputHandler) Writes the content of this widget to an XML content handler.

Methods inherited from class org.eclipse.vtp.framework.interactions.voice.vxml.FormElement

getCondition, getExpression, getName, setCondition, setExpression, setName

Methods inherited from class org.eclipse.vtp.framework.interactions.core.support.Widget

toString, writeAttribute, writeChildren, writeChildren, writeWidget, writeWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Recording

public Recording(java.lang.String name)
          throws java.lang.IllegalArgumentException,
                 java.lang.NullPointerException

Creates a new instance of a Recording element.

Parameters:

name - The name of the recording element.

Throws:

java.lang.IllegalArgumentException - If the specified name is empty.

java.lang.NullPointerException - If the specified name is null.

Recording

public Recording(java.lang.String name,
                 java.lang.String expression)
          throws java.lang.IllegalArgumentException,
                 java.lang.NullPointerException

Creates a new instance of a Recording element.

Parameters:

name - The name of the recording element.

expression - An expression that will set the initial value of the recording element.

Throws:

java.lang.IllegalArgumentException - If the specified name is empty.

java.lang.IllegalArgumentException - If the specified expression is empty.

java.lang.NullPointerException - If the specified name is null.

Recording

public Recording(java.lang.String name,
                 java.lang.String expression,
                 java.lang.String condition)
          throws java.lang.IllegalArgumentException,
                 java.lang.NullPointerException

Creates a new instance of a Recording element.

Parameters:

name - The name of the recording element.

expression - An expression that will set the initial value of the recording element.

condition - An expression that equates to a boolean value which determines if the recording will be executed.

Throws:

java.lang.IllegalArgumentException - If the specified name is empty.

java.lang.IllegalArgumentException - If the specified expression is empty.

java.lang.IllegalArgumentException - If the specified condition is empty.

java.lang.NullPointerException - If the specified name is null.

Method Detail

isBeepEnabled

public boolean isBeepEnabled()

Returns the beep toggle setting.

Returns:

The beep toggle setting.

isDtmfTermEnabled

public boolean isDtmfTermEnabled()

Returns the DTMF toggle setting.

Returns:

The DTMF toggle setting.

getMaxtime

public java.lang.String getMaxtime()

Returns the maximum recording time setting.

Returns:

The maximum recording time setting.

getFinalSilence

public java.lang.String getFinalSilence()

Returns the final silence setting.

Returns:

The final silence setting.

getFileType

public java.lang.String getFileType()

Returns the file type setting.

Returns:

The file type setting.

getTimeout

public java.lang.String getTimeout()

Returns the time out of the opening prompt.

Returns:

The time out of the opening prompt.

getPrompt

public Prompt getPrompt()

Returns the opening prompt played to the caller.

Returns:

The opening prompt played to the caller.

getPropertyNames

public java.lang.String[] getPropertyNames()

Returns the names of the properties of this recording.

Returns:

The names of the properties of this recording.

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String propertyName)
                                  throws java.lang.NullPointerException

Returns the value of the specified property or null if no such property exists.

Parameters:

propertyName - The name of the property to find the value of.

Returns:

The value of the specified property or null if no such property exists.

Throws:

java.lang.NullPointerException - If the supplied property name is null.

setBeepEnabled

public void setBeepEnabled(boolean beepEnabled)

Sets the beep toggle setting.

Parameters:

beepEnabled - The beep toggle setting.

setDtmfTermEnabled

public void setDtmfTermEnabled(boolean dtmfTermEnabled)

Sets the DTMF toggle setting.

Parameters:

dtmfTermEnabled - The DTMF toggle setting.

setMaxtime

public void setMaxtime(java.lang.String maxtime)
                throws java.lang.IllegalArgumentException

Sets the maximum recording time setting.

Parameters:

maxtime - The maximum recording time setting.

Throws:

java.lang.IllegalArgumentException - If the specified setting is empty.

setFinalSilence

public void setFinalSilence(java.lang.String finalSilence)
                     throws java.lang.IllegalArgumentException

Sets the final silence setting.

Parameters:

finalSilence - The final silence setting.

Throws:

java.lang.IllegalArgumentException - If the specified setting is empty.

setFileType

public void setFileType(java.lang.String fileType)
                 throws java.lang.IllegalArgumentException

Sets the file type setting.

Parameters:

fileType - The file type setting.

Throws:

java.lang.IllegalArgumentException - If the specified setting is empty.

setTimeout

public void setTimeout(java.lang.String timeout)
                throws java.lang.IllegalArgumentException

Sets the time out of the opening prompt.

Parameters:

timeout - The time out of the opening prompt.

Throws:

java.lang.IllegalArgumentException - If the specified setting is empty.

setPrompt

public void setPrompt(Prompt prompt)

Sets the opening prompt played to the caller.

Parameters:

prompt - The opening prompt played to the caller.

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.String propertyValue)
                 throws java.lang.NullPointerException

Sets the value of a property in this recording.

Parameters:

propertyName - The name of the property to set.

propertyValue - The value to set the property to.

Throws:

java.lang.NullPointerException - If the supplied property name or value is null.

clearProperty

public void clearProperty(java.lang.String propertyName)
                   throws java.lang.NullPointerException

Clears the value of a property in this recording.

Parameters:

propertyName - The name of the property to clear.

Throws:

java.lang.NullPointerException - If the supplied property name is null.

addFilledHandler

public void addFilledHandler(Filled filled)
                      throws java.lang.NullPointerException

Adds the specified filled handler to this recording. The filled handlers will be executed in the order they were added.

Parameters:

filled - The filled handler to be added.

Throws:

java.lang.NullPointerException - If the supplied filled handler is null.

removeFilledHandler

public void removeFilledHandler(Filled filled)
                         throws java.lang.NullPointerException

Removes the specified filled handler from this recording.

Parameters:

filled - The filled handler to be removed.

Throws:

java.lang.NullPointerException - If the supplied filled handler is null.

addEventHandler

public void addEventHandler(EventHandler eventHandler)
                     throws java.lang.NullPointerException

Adds the specified event handler to this recording. The event handlers are evaluated in the order they were added.

Parameters:

eventHandler - The event handler to add.

Throws:

java.lang.NullPointerException - If the supplied event handler is null.

removeEventHandler

public void removeEventHandler(EventHandler eventHandler)
                        throws java.lang.NullPointerException

Removes the specified event handler from this recording.

Parameters:

eventHandler - The event handler to remove.

Throws:

java.lang.NullPointerException - If the supplied event handler is null.

writeWidget

public void writeWidget(org.xml.sax.ContentHandler outputHandler)
                 throws java.lang.NullPointerException,
                        org.xml.sax.SAXException

Description copied from class: Widget

Writes the content of this widget to an XML content handler.

Specified by:

writeWidget in class Widget

Parameters:

outputHandler - The handler to write this widget to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of this widget fails.

writeAttributes

protected void writeAttributes(org.xml.sax.helpers.AttributesImpl attributes)

Description copied from class: FormElement

Write the attribute members of this form element to the supplied set.

Overrides:

writeAttributes in class FormElement

Parameters:

attributes - The attribute set to write to.

writePrompt

protected void writePrompt(org.xml.sax.ContentHandler outputHandler)
                    throws java.lang.NullPointerException,
                           org.xml.sax.SAXException

Writes this field's prompt to the specified content handler.

Parameters:

outputHandler - The handler to write the properties to.

Throws:

org.xml.sax.SAXException - If the writing of the prompt fails.

java.lang.NullPointerException - If the supplied content handler is null.

writeProperties

protected void writeProperties(org.xml.sax.ContentHandler outputHandler)
                        throws java.lang.NullPointerException,
                               org.xml.sax.SAXException

Writes the properties of this field to the specified content handler.

Parameters:

outputHandler - The handler to write the properties to.

Throws:

org.xml.sax.SAXException - If the writing of the properties fails.

java.lang.NullPointerException - If the supplied content handler is null.

writeFilledHandlers

protected void writeFilledHandlers(org.xml.sax.ContentHandler outputHandler)
                            throws java.lang.NullPointerException,
                                   org.xml.sax.SAXException

Write the filled handlers of this field to the specified content handler.

Parameters:

outputHandler - The content handler to write to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of one of the filled handlers fails.

writeEventHandlers

protected void writeEventHandlers(org.xml.sax.ContentHandler outputHandler)
                           throws java.lang.NullPointerException,
                                  org.xml.sax.SAXException

Write the event handlers of this field to the specified content handler.

Parameters:

outputHandler - The content handler to write to.

Throws:

java.lang.NullPointerException - If the supplied content handler is null.

org.xml.sax.SAXException - If the writing of one of the event handlers fails.